<meta charset="utf-8">
(#) Navigation route should be an object literal or a destination class instance with arguments

!!! ERROR: Navigation route should be an object literal or a destination class instance with arguments
   This is an error.

Id
:   `WrongNavigateRouteType`
Summary
:   Navigation route should be an object literal or a destination class instance with arguments
Severity
:   Error
Category
:   Correctness
Platform
:   Any
Vendor
:   Android Open Source Project
Identifier
:   androidx.navigation.runtime
Feedback
:   https://issuetracker.google.com/issues/new?component=409828
Min
:   Lint 8.0 and 8.1
Compiled
:   Lint 8.7+
Artifact
:   [androidx.navigation:navigation-runtime](androidx_navigation_navigation-runtime.md.html)
Since
:   2.8.0
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/navigation/navigation-runtime-lint/src/main/java/androidx/navigation/runtime/lint/WrongNavigateRouteDetector.kt)
Tests
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/WrongNavigateRouteDetectorTest.kt)
Copyright Year
:   2024

If the destination class contains arguments, the route is expected to be
class instance with the arguments filled in.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/com/example/test.kt:7:Error: The route should be a destination class
instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = TestClass)
                                   ---------
src/com/example/test.kt:8:Error: The route should be a destination class
instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = TestClass::class)
                                   ----------------
src/com/example/test.kt:9:Error: The route should be a destination class
instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = TestClassWithArg)
                                   ----------------
src/com/example/test.kt:10:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = TestClassWithArg::class)
                                   -----------------------
src/com/example/test.kt:11:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = TestInterface)
                                   -------------
src/com/example/test.kt:12:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = TestInterface::class)
                                   --------------------
src/com/example/test.kt:13:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = InterfaceChildClass)
                                   -------------------
src/com/example/test.kt:14:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = InterfaceChildClass::class)
                                   --------------------------
src/com/example/test.kt:15:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = TestAbstract)
                                   ------------
src/com/example/test.kt:16:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = TestAbstract::class)
                                   -------------------
src/com/example/test.kt:17:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = AbstractChildClass)
                                   ------------------
src/com/example/test.kt:18:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = AbstractChildClass::class)
                                   -------------------------
src/com/example/test.kt:19:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = InterfaceChildClass::class)
                                   --------------------------
src/com/example/test.kt:20:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = Outer.InnerClass)
                                   ----------------
src/com/example/test.kt:21:Error: The route should be a destination
class instance or destination object. [WrongNavigateRouteType]
    navController.navigate(route = Outer.InnerClass::class)
                                   -----------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/com/example/test.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package com.example

import androidx.navigation.*

fun createGraph() {
    val navController = NavController()
    navController.navigate(route = TestClass)
    navController.navigate(route = TestClass::class)
    navController.navigate(route = TestClassWithArg)
    navController.navigate(route = TestClassWithArg::class)
    navController.navigate(route = TestInterface)
    navController.navigate(route = TestInterface::class)
    navController.navigate(route = InterfaceChildClass)
    navController.navigate(route = InterfaceChildClass::class)
    navController.navigate(route = TestAbstract)
    navController.navigate(route = TestAbstract::class)
    navController.navigate(route = AbstractChildClass)
    navController.navigate(route = AbstractChildClass::class)
    navController.navigate(route = InterfaceChildClass::class)
    navController.navigate(route = Outer.InnerClass)
    navController.navigate(route = Outer.InnerClass::class)
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/WrongNavigateRouteDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `WrongNavigateRouteDetector.testHasError`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=409828.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.navigation:navigation-runtime:2.9.0-alpha04")

// build.gradle
implementation 'androidx.navigation:navigation-runtime:2.9.0-alpha04'

// build.gradle.kts with version catalogs:
implementation(libs.navigation.runtime)

# libs.versions.toml
[versions]
navigation-runtime = "2.9.0-alpha04"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
navigation-runtime = {
    module = "androidx.navigation:navigation-runtime",
    version.ref = "navigation-runtime"
}
```

2.9.0-alpha04 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.navigation:navigation-runtime](androidx_navigation_navigation-runtime.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("WrongNavigateRouteType")
  fun method() {
     navigate(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("WrongNavigateRouteType")
  void method() {
     navigate(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection WrongNavigateRouteType
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="WrongNavigateRouteType" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'WrongNavigateRouteType'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore WrongNavigateRouteType ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>